/*
 * MIT License
 *
 * Stream-rec  https://github.com/hua0512/stream-rec
 *
 * Copyright (c) 2024 hua0512 (https://github.com/hua0512)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package github.hua0512.dao.upload

import github.hua0512.data.UploadActionId
import github.hua0512.data.UploadDataId
import github.hua0512.utils.UploadActionEntity
import github.hua0512.utils.UploadActionFilesEntity

/**
 * Interface for managing upload action files.
 * Provides methods for retrieving upload action files and inserting new ones.
 *
 * @author hua0512
 * @date : 2024/2/19 12:20
 */
interface UploadActionFilesDao {

  /**
   * Retrieves an upload action by its associated upload data ID.
   *
   * @param uploadDataId The ID of the upload data
   * @return UploadActionEntity or null if no upload action with the given upload data ID exists
   */
  fun getUploadActionByUploadDataId(uploadDataId: UploadDataId): UploadActionEntity?

  /**
   * Retrieves an upload action file by its associated upload data ID.
   *
   * @param uploadDataId The ID of the upload data
   * @return UploadActionFilesEntity or null if no upload action file with the given upload data ID exists
   */
  fun getUploadActionFileByUploadDataId(uploadDataId: UploadDataId): UploadActionFilesEntity?

  /**
   * Retrieves all upload action files associated with a specific action ID.
   *
   * @param actionId The ID of the upload action
   * @return List of UploadActionFilesEntity
   */
  fun getUploadActionFilesByActionId(actionId: UploadActionId): List<UploadActionFilesEntity>

  /**
   * Inserts new upload action files.
   *
   * @param uploadActionId The ID of the upload action
   * @param uploadDataId The ID of the upload data
   */
  fun insertUploadActionFiles(uploadActionId: UploadActionId, uploadDataId: UploadDataId)
}